Skip to content

Automate ADR-backed component review guidance#8174

Draft
adierkens wants to merge 2 commits into
adierkens-prototype-adr-reviewerfrom
adierkens-adr-review-automation
Draft

Automate ADR-backed component review guidance#8174
adierkens wants to merge 2 commits into
adierkens-prototype-adr-reviewerfrom
adierkens-adr-review-automation

Conversation

@adierkens

@adierkens adierkens commented Jul 16, 2026 •
edited
Loading

Copy link
Copy Markdown
Contributor

Closes #

Builds on #8173's small ADR-backed review trial by replacing its hand-authored instruction with a complete, validated policy generation system. Public ADRs and maintained contributor guidance produce path-scoped Copilot Code Review instructions; sanitized internal direction is limited to outcome-only rules.

Changelog

New

  • Structured public and outcome-only internal policy manifests
  • Deterministic path-scoped instruction generation
  • Reusable component-review skill and read-only reviewer agent
  • Schema, privacy, source-digest, and generated-output tests

Changed

  • Replaces the base PR trial instruction with the generated policy catalog
  • ADR authoring guidance identifies review-policy impact
  • CI checks generated guidance and lint autofix regenerates stale output

Removed

  • The hand-authored four-rule trial instruction from the base PR

Rollout strategy

  • Patch release
  • Minor release
  • Major release; if selected, include a written rollout or migration plan
  • None; review tooling, documentation, and CI only. No published package behavior changes.

Testing & Reviewing

Review this after the base trial establishes that path-scoped ADR rules produce useful CCR feedback. Compare contributor-docs/review-guidance/ with the generated instructions and consolidated skill reference. The internal policy intentionally excludes private provenance, identifiers, rationale, links, and alternatives.

Run npm run test:review-guidance and npm run check:review-guidance.

@adierkens adierkens added the skip changeset This change does not need a changelog label Jul 16, 2026
@github-actions github-actions Bot added the integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm label Jul 16, 2026
@github-actions

github-actions Bot commented Jul 16, 2026

Copy link
Copy Markdown
Contributor

⚠️ Action required

👋 Hi, this pull request contains changes to the source code that github/github-ui depends on. If you are GitHub staff, test these changes with github/github-ui using the integration workflow. If this doesn't work, you can also use the original workflow here. Check the integration testing docs for step-by-step instructions. Or, apply the integration-tests: skipped manually label to skip these checks.

To publish a canary release for integration testing, apply the Canary Release label to this PR.

adierkens added 2 commits July 16, 2026 15:56
@adierkens
Add ADR-backed component review guidance
423d236 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 68a3cde5-7a50-4d4e-97d9-194c8b112e88
@adierkens
Replace trial rules with generated policy
e9ca907 
Co-authored-by: Copilot App <223556219+Copilot@users.noreply.github.com>

Copilot-Session: 68a3cde5-7a50-4d4e-97d9-194c8b112e88
@adierkens
adierkens force-pushed the adierkens-adr-review-automation branch from 51876a1 to e9ca907 Compare July 16, 2026 19:57
@changeset-bot

changeset-bot Bot commented Jul 16, 2026

Copy link
Copy Markdown

⚠️ No Changeset found

Latest commit: e9ca907

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

@adierkens adierkens mentioned this pull request Jul 16, 2026
Open
4 tasks
@github-actions
github-actions Bot requested a deployment to storybook-preview-8174 July 16, 2026 20:01 Abandoned
joshblack
joshblack reviewed Jul 17, 2026
View reviewed changes

@joshblack joshblack left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I tried running this to see what kind of stuff it would output and I was surprised that it didn't seem to honor some of the ADRs 🤔

As an example, I tried to create an accordion component locally and was surprised that it didn't follow the file conventions ADR to include a test file.

Could you do like a before/after kind of approach for what this kind of stuff would help out with compared to baseline? In just a one-off test it didn't seem to provide a better outcome but I also get how unscientific that is lol.

Happy to keep testing if that would be better, just wanted to leave a note while looking at this today 👀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@joshblack joshblack joshblack left review comments

Assignees

No one assigned

Labels

integration-tests: recommended This change needs to be tested for breaking changes. See https://arc.net/l/quote/tdmpakpm skip changeset This change does not need a changelog

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

2 participants

@adierkens @joshblack